package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CompanyEmpNecessaryAddDTO;
import org.jsola.hr.dto.CompanyEmpNecessaryUpdateDTO;
import org.jsola.hr.query.CompanyEmpNecessaryQuery;
import org.jsola.hr.vo.CompanyEmpNecessaryListVO;
import org.jsola.hr.vo.CompanyEmpNecessaryVO;

import java.util.List;

/**
 * 公司员工必填模块信息
 *
 * @author zhr
 */
@Api(tags = "hr-公司员工必填模块信息")
public interface ICompanyEmpNecessaryControllerAPI {

    /**
     * 新增公司员工必填模块信息
     * @param companyEmpNecessaryAddDTO 公司员工必填模块信息新增实体
     * @return 公司员工必填模块信息展示对象
     */
    @ApiOperation(value = "新增公司员工必填模块信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryAddDTO", dataType = "CompanyEmpNecessaryAddDTO", value = "新增公司员工必填模块信息", paramType = "body")
    })
    Result<CompanyEmpNecessaryVO> save(CompanyEmpNecessaryAddDTO companyEmpNecessaryAddDTO);


    /**
     * 修改公司员工必填模块信息
     * @param companyEmpNecessaryUpdateDTO 公司员工必填模块信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改公司员工必填模块信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryUpdateDTO", dataType = "CompanyEmpNecessaryUpdateDTO", value = "修改公司员工必填模块信息", paramType = "body")
    })
    Result<Integer> update(CompanyEmpNecessaryUpdateDTO companyEmpNecessaryUpdateDTO);




    /**
     * 删除单个公司员工必填模块信息，彻底删除
     * @param companyEmpNecessaryId 公司员工必填模块信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公司员工必填模块信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryId", dataType = "String", value = "公司员工必填模块信息id", paramType = "path")
    })
    Result<Integer> delete(String companyEmpNecessaryId);


    /**
     * 批量删除公司员工必填模块信息，彻底删除
     * @param companyEmpNecessaryIds 公司员工必填模块信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司员工必填模块信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryIds", dataType = "String[]", value = "公司员工必填模块信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] companyEmpNecessaryIds);


    /**
     * 根据公司员工必填模块信息id查询公司员工必填模块信息详情
     * @param companyEmpNecessaryId 公司员工必填模块信息id
     * @return 公司员工必填模块信息详情
     */
    @ApiOperation(value="根据公司员工必填模块信息id查询公司员工必填模块信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryId", dataType = "String", value = "公司员工必填模块信息id", paramType = "path")
    })
    Result<CompanyEmpNecessaryVO> findById(String companyEmpNecessaryId);


    /**
     * 查询公司员工必填模块信息
     * @param companyEmpNecessaryQuery 公司员工必填模块信息查询参数
     * @return page
     */
    @ApiOperation(value="查询公司员工必填模块信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryQuery", dataType = "CompanyEmpNecessaryQuery", value = "公司员工必填模块信息查询参数", paramType = "query")
    })
    Result<List<CompanyEmpNecessaryListVO>> listAll(CompanyEmpNecessaryQuery companyEmpNecessaryQuery);


     /**
     * 分页查询公司员工必填模块信息
     * @param companyEmpNecessaryQuery 公司员工必填模块信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公司员工必填模块信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyEmpNecessaryQuery", dataType = "CompanyEmpNecessaryQuery", value = "公司员工必填模块信息查询参数", paramType = "query")
    })
    Result<Page<CompanyEmpNecessaryListVO>> page(CompanyEmpNecessaryQuery companyEmpNecessaryQuery);


}

